Cobra Utilities for Doom & Doom II/Cobra Utilities For Doom & Doom II - Disc 2.iso/files/program/doomez12/readme.doc

Text File | 1994-03-13 | 11.7 KB | 221 lines

                  DOCUMENTATION FILE FOR DOOMEZ VER 1.2

***************************************
***************************************
PLEASE READ:

This v.1.2 of DOOMEZ supports alteration of DOOM 1.2 MODEM save files.  The
modem command, "modem", has been added to the list of possible DOOMFIX.CFG
commands.  This command will cause BOTH player 1 and player 2 to be edited
with the same alterations. (I debated on whether or not to allow users to have
the capability of editing modem players 1 and 2 separately, and decided that
in the interests of game "fairness", both players should get equal editing.
If you would like to edit modem players separately, please contact me.)  Note
that you must be running DOOM 1.2, and you must have the "ver 1.2" command in
DOOMFIX.CFG before the "modem" command will work. ALTHOUGH THE "modem" COMMAND
GIVES YOU MUCH MORE EDITING POWER, IT IS A VERY DANGEROUS COMMAND AS WELL.
IT CAN POTENTIALLY DESTROY A NON-MODEM SAVE FILE, SO USE IT CAREFULLY!

This version of DOOMEZ supports DOOM versions 1.1 and 1.2.  DOOMFIX must be
told which version of DOOM you are running.  (There are so many non-constant
internal variables in the DOOM save files that I decided to have the user
command DOOMFIX with the DOOM version number rather than having DOOMFIX
read a DOOM save file and then try to decide which version of DOOM you are
running.)  To command DOOMFIX to configure with your version of DOOM, just add
a "ver 1.1" or "ver 1.2" command (separated by spaces) to your DOOMFIX.CFG
file's top data line. If you omit the "ver" command in DOOMFIX.CFG, DOOMFIX
will ASSUME you are running DOOM 1.2!

DOOMEZ installation is now dependent upon which version of DOOM you're using.
If using DOOM 1.2, install all DOOMEZ files to your \doom area.  If you are
still running DOOM 1.1, install PLAYDOOM.BAT to your \doom area, and install
the DOOMFIX files to your \doomdata area.

Note that you may have to alter PLAYDOOM.BAT depending on which version of
DOOM you are running.  If you need to edit it, only one line will require
alteration. Look at the PLAYDOOM.BAT file and find the notes highlighted with
# characters.

Most of the text that follows is the same as that included in version 1.0 of
DOOMEZ.
***************************************
***************************************


DOOMEZ allows you to play any DOOM episode and mission while getting special
weapons, ammo, and super powers.  It consists of a batch file, PLAYDOOM.BAT,
and two DOOMFIX files - DOOMFIX.EXE and DOOMFIX.CFG.   PLAYDOOM is the file
you will call for running this system and DOOMFIX is a special "in-line" DOOM
save file editor.  PLAYDOOM runs DOOM in "developmental" mode -- a special
mode which lets you do things such as warp to individual missions, setup
skill levels, etc.  Since the DOOM developmental mode lets you do these things,
you may ask, "Why do I need DOOMEZ when DOOM already lets me play any mission
I want?"  The answer is that even though DOOM will send you to any mission, you
will begin that mission with very little weapons, ammo, etc.  DOOM has a special
"cheat" mode that will let you give yourself special ammo, health, and other
things.  This mode is called during gameplay and consists of commands such as
"iddqd", "idbehold", etc.  These modes are useful but you STILL don't get
big weapon loads, super armour, etc.  DOOMFIX gives you lots of goodies that
the built-in DOOM controls don't.

PLEASE NOTE that you only need to run PLAYDOOM.BAT when you want to jump
to a DOOM mission that is out-of-series with the ones you are currently
playing.  Once you've run PLAYDOOM.BAT and you have a "super" DOOM save file,
play DOOM normally until ready to skip to a new out-of-series mission.

DOOMFIX is a powerful DOOM save game editor.  In the DOOMEZ package, it runs
as part of PLAYDOOM.BAT.  Read the discussion on DOOMFIX later in this file
and then feel free to experiment with DOOMFIX.  It can be run on ANY DOOM save
game file and there are MANY save game settings you can play with.  The DOOMEZ
package comes with a "generic" DOOMFIX.CFG configuration file that I threw
together just to illustrate some of the things DOOMFIX can do.





*******************************************************************************
                          INSTALLATION

Run PLAYDOOM by typing "playdoom" followed by command line arguments for the
episode, mission, and skill level you want.  Episodes are numbered 1-3, missions
are numbered 1-9, and skill levels are 1-5 for DOOM 1.2 (1-4 in DOOM 1.1).
Typing "playdoom 3 2 4" will run episode 3, mission 2, and skill level 4 in
single-player mode.  Typing "playdoom" with no command line arguments will give
you usage info.

Once begun, PLAYDOOM will run DOOM using the passed-in arguments. When DOOM
has finished its opening setup and has given you a play screen, SAVE THE GAME
BY PRESSING "F2" AND SELECT THE TOP SAVE GAME SLOT FOR SAVING. YOU MUST USE THE
TOP SLOT IN ORDER TO WRITE THE DOOMSAV0.DSG SAVE GAME FILE.  DOOMEZ is packaged
and setup to use the DOOMSAV0.DSG save game file. Once you understand how
PLAYDOOM and DOOMFIX work, feel free to change the save game file from
doomsav0.dsg to any other DOOM save file.  Once again, DO NOT PLAY THE LOADED
GAME, JUST SAVE IT IN THE TOP SAVE SLOT IN THE SAVE MENU AND EXIT DOOM!  (DOOM
save game files are VERY complex, and you must rely on DOOM to give you an
initial episode, mission, and skill level setup.  This first run of DOOM gives
you a working save game file.)

Once DOOM has exited, DOOMFIX will take over and will edit the DOOMSAV0.DSG
save game file.  You will see a listing of the items that DOOMFIX is changing.
See the following discussions on DOOMFIX if you want to change the items
edited.

Once DOOMFIX has finished, DOOM will begin again using the edited save game
file.  You will notice major changes in your configuration -- more weapons,
ammo, armour, etc.  Play DOOM normally from here on.  Your edited save game
file is just a starting point for a mission.  Save over it or reload it
whenever you want.





*******************************************************************************
                              DOOMFIX OPERATIONS

DOOMFIX is an "in-line" DOOM save file editor.  Rather than presenting you
with menues of items for editing, DOOMFIX reads a customized configuration
file which tells it how to edit your save file.  This configuration file,
DOOMFIX.CFG, is a simple ASCII text file that has only ONE ACTIVE LINE OF
DATA.  The top data line in DOOMFIX.CFG is all that is read by DOOMFIX, and
any editing you need to do is done on this single data line.  Print out the
DOOMFIX.CFG file that came with DOOMEZ.  You will notice this file gives you
a listing of all the available DOOMFIX commands.  Here are the rules for
editing DOOMFIX.CFG:
    1)    All commands are on the top data line in the file.
    2)    All commands are separated by space characters.  Carriage
        returns, line feeds, and other control characters are not
        allowed as command delimiters or separators in the data line.
    3)    Some commands consist of more than one string.  Be sure to enter
        ALL of the command.  For example, the "inv" command requires
        two extra parameters.  The command "inv 3 25" will make you
        invisible for 3 minutes 25 seconds.  All ammo load commands
        have two extra parameters - the first being the ammo load and
        the second being the max possible load for that type of ammo.
        The command "r 400 550" will load you with 400 rockets and your
        current max rocket count is 550.  All parts of a command are
        separated with space characters.
    4)    The commands can be entered in any order.  Just keep all the
        parts of a single command together.  The length of the data
        line isn't critical.
    5)      VERY IMPORTANT!  The LAST item in the command list MUST be the
        name of the DOOM save file being edited.  The DOOMFIX.CFG
        that came with DOOMEZ has the filename DOOMSAV0.DSG as the
        last item in the command list.  THIS IS WHY YOU MUST USE THE
        TOP SAVE SLOT IN THE GAME FOR SAVING DATA. The top slot writes
        data to doomsav0.dsg.  Feel free to change the last command
        item filename to any other filename you want.  Just remember
        what save filename you are editing!
    6)    Once the commands and the trailing save filename have been
        entered into the data line, just hit "return" or "enter" to
        add a carriage return to the end of the line.  This will tell
        DOOMFIX to stop reading the configuration data.  You can type
        anything else you want into the file at this point -- personal
        notes, descriptions of your edits, etc.  DOOMFIX READS THE TOP
        DATA LINE ONLY!
    7)    DOOMFIX supports DOOM 1.1 and 1.2 via a command in DOOMFIX.CFG.
            Tell DOOMFIX which version of DOOM you are running via the
        "ver 1.1" and "ver 1.2" commands.
    8)     DOOMFIX will edit a MODEM save file (both players are edited)
        via the "modem" command.  Be careful with this command!

Editing the DOOMFIX.CFG is easy.  Here's an example of the top (and only) data
line in a DOOMFIX.CFG file (note that only space characters are used to separate
the commands and that a save filename is the last item in the list:

ver 1.2 modem a 200 bk ysk rs 3 20 rl r 300 400 iddqd doomsav0.dsg

The above example gives you armour at 200%, a blue key, a yellow skeleton key,
a radiation suit that will be active for 3 minutes 20 seconds, a rocket
launcher, a rocket load of 300 with a max of 400 rockets, put you in "god"
mode where you can't be hurt, and finally the doomsav0.dsg file will be the
target of these edits.  The "ver 1.2" command will tell DOOMFIX to write the
save file in DOOM 1.2 format and the "modem" command will cause both players
in this file to be edited.  The save file was created during modem play,
otherwise you would NOT use the "modem" command!  Experiment with your own
DOOMFIX.CFG files.  Be weary of very large, unusual parameters such as a health
of 500% or ammo loads over 999 pieces of a single type of ammo.  You may get
very unexpected results! For more DOOMFIX info, type "DOOMFIX ?".

Once you feel comfortable editing the DOOMFIX.CFG file commands, try editing
DOOM save files outside of the PLAYDOOM.BAT routine.  Use it as you would
any save file editor, with the exception being that you tell the routine what
to edit via a configuration file as opposed to selecting menu items on a
screen.





*******************************************************************************
                         FINAL COMMENTS
DOOMEZ was not written to allow one to cheat his/her way through DOOM.
It is intended as a tool to allow your progression through DOOM in a
shorter-than-normal time span while still giving you LOTS of enjoyment and
fun with experimentation.  Please use it with this attitude in mind.

If you have any questions or comments concerning this program, or YOU WISH TO
MAKE A DONATION of $5 (please make any checks payable to WAYNE SIKES), please
contact me at:

Wayne Sikes
435 Sego Lily
Bosque Farms, NM  87068

CompuServe:        70733,1562
Phone:      [phone] (home)
        (505)-844-8658 (work)

Feel free to distribute copies of these programs. The only thing I ask is
that you DO NOT MODIFY this text file, PLAYDOOM.BAT, or the DOOMFIX routines
prior to distribution.  When distributing, PLEASE ALWAYS INCLUDE A COPY OF
THIS TEXT FILE.  If you include these programs in any retail or wholesale
software packages, compilations, libraries, archives, etc. please contact
me.  As with all my analysis and engineering software, these programs are
copywritten by K & W Computer Works.

Thank you for using DOOMEZ and enjoy DOOM!
*********************  END OF README.DOC FILE ***********************